/*
 * Project it.battlehorse.rcp.tools.commons
 * Created on Nov 18, 2005
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * A copy of the LGPL is available also at
 * http://www.gnu.org/copyleft/lesser.html
 * 
 */ 
package it.battlehorse.rcp.tools.commons.actors;

import it.battlehorse.rcp.tools.commons.Severity;

import java.util.List;

/**
 * Represents a validation status which generically defines if a given resource
 * or component is valid or not.
 * 
 * @author battlehorse
 * @since Nov 18, 2005
 */
public interface IValidationStatus {		
	
	/**
	 * Returns an informative message about the validation status.
	 * 
	 * @return an informative message about the validation status.
	 */
	public String getValidationMessage();
		
	/**
	 * Defines if the resource validated by this class is correctly configured or not.
	 * 
	 * @return {@code true} if the resource is correctly configured, {@code false}
	 * 		otherwise.
	 */
	public boolean isValid();
	
	/**
	 * Returns a list of optional sub validation status messages, if needed.
	 * 
	 * @return a list of optional sub validation status messages, or {@code null}
	 * 		otherwise.
	 */
	public List<IValidationStatus> getSubStatuses();
	
	/**
	 * Returns the severity of this validation status.
	 * 
	 * @return the severity of this validation status.
	 */
	public Severity getSeverity();

}
